Improve disable_init docs and export the metaclass
#55
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Leandro Lucarella <[email protected]>
This effectively make it public. We need this in case users want to combine the metaclass with other metaclasses, like `abc.ABCMeta`. Signed-off-by: Leandro Lucarella <[email protected]>
llucax
added
the
cmd:skip-release-notes
The new recommendation actually doesn't work. The correct way to do it would be: ```py super(cls, self).__init__() ``` But this is not even necessary when you are applying the decorator to a simple class that doesn't inherit from anything (i.e. inherits from `object` directly). Applying the decorators to other sub-classes, is much trickier than just addint the `super()` call, so we will just not recommend or support doing that and keep the usage documentation simple. This reverts commit 073b921. Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
improve-disable-init
branch
from
e7161b8 to
f1a8db6
Compare
There was a problem hiding this comment.
Pull Request Overview
This pull request improves the documentation for the disable_init decorator and exports the NoInitConstructibleMeta metaclass. Key changes include updating docstrings and examples to clarify the use of the metaclass, removing unnecessary calls to super().init(self) in factory methods, and adjusting keyword arguments handling in error generation functions.
Comments suppressed due to low confidence (1)
src/frequenz/core/typing.py:176
- [nitpick] The documentation example uses 'meta' to specify the metaclass. Consider using the standard 'metaclass' keyword (i.e. 'class MyClass(metaclass=NoInitConstructibleMeta):') for clarity, if that is supported in your context.
class MyClass(meta=NoInitConstructibleMeta):
Improve the docs to point out that disabling the `__init__` for existing classes via a sub-class is complicated, so it is only recommended to use both the decorator and metaclass on classes inheriting from `object` directly. Also improve the documentation of `NoInitConstructibleMeta` to be more complete and give an example on using with `abc.ABCMeta`. Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
improve-disable-init
branch
from
f1a8db6 to
cb4c104
Compare
ela-kotulska-frequenz
approved these changes
Mar 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve the docs to point out that disabling the
__init__for existing classes via a sub-class is complicated, so it is only recommended to use both the decorator and metaclass on classes inheriting fromobjectdirectly.Also make
NoInitConstructibleMetapublic (remove the_prefix from the name) and improve its documentation to be more complete and give an example on using withabc.ABCMeta.